//----------------------------------------------------------------------------
//
// TSDuck - The MPEG Transport Stream Toolkit
// Copyright (c) 2005-2022, Thierry Lelegard
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
//----------------------------------------------------------------------------
//!
//!  @file
//!  Command-line options for one plugin.
//!
//----------------------------------------------------------------------------

#pragma once
#include "tsPlugin.h"

namespace ts {
    //!
    //! Command-line options for one plugin.
    //! @ingroup plugin
    //!
    class TSDUCKDLL PluginOptions
    {
    public:
        //!
        //! Default constructor.
        //! @param [in] name Plugin name.
        //! @param [in] args Plugin arguments.
        //!
        PluginOptions(const UString& name = UString(), const UStringVector& args = UStringVector());

        //!
        //! Set values.
        //! @param [in] name Plugin name.
        //! @param [in] args Plugin arguments.
        //!
        void set(const UString& name, const UStringVector& args = UStringVector());

        //!
        //! Clear the content of the options.
        //!
        void clear();

        //!
        //! Format the options as a string.
        //! @param [in] type Plugin type.
        //! @return The command line equivalent.
        //!
        UString toString(PluginType type) const;

        UString       name;  //!< Plugin name.
        UStringVector args;  //!< Plugin options.
    };

    //!
    //! A vector of plugin options, representing a processing chain.
    //!
    typedef std::vector<PluginOptions> PluginOptionsVector;
}
